.\" TODO:
.\" - estats_types?  (what is a ESTATS_TYPE, ESTATS_ADDRTYPE, ...)
.TH libestats 3 "15 May 2011" "Estats Userland" "Estats"
.SH NAME
libestats \- Estats connection statistics handling and manipulation library
.SH SYNOPSIS
.B #include <estats/estats.h>
.SH DESCRIPTION
The \fBlibestats\fR library routines give the user an OS-independent
method of accessing and manipulating the TCP connection statistics
exposed by the Estats kernel.
.PP
As the \fBlibestats\fR header may be installed into a directory that the
compiler does not automatically search for, developer's should use the
output from \fIestats-config --cflags\fR to instruct the compiler to
search in the correct directory.
.PP
A program using these routines must be linked with the \fB-lestats\fR
option.  Using the output from \fIestats-config --libs\fR is a simple
way to ensure that the library is found and linked in correctly.
.PP
.SS Routine Name Index
The following table lists each \fBlibestats\fR
routine and the name of the master manual page on which it is described
(man "\fIroutine_name\fR" redirects to this page):
.PP
.nf
\fBlibestats\fR Routine Name                    Manual Page Name
======================                    ======================
estats_agent_attach                       \fBestats_agent_attach\fR(3)
estats_agent_detach                       \fBestats_agent_attach\fR(3)

estats_agent_find_connection_from_cid     \fBestats_find_connection\fR(3)
estats_agent_find_connection_from_socket  \fBestats_find_connection\fR(3)
estats_agent_find_connection_from_spec    \fBestats_find_connection\fR(3)
estats_agent_get_connection_head          \fBestats_find_connection\fR(3)
estats_connection_next                    \fBestats_find_connection\fR(3)

estats_connection_get_addrtype            \fBestats_connection_accessors\fR(3)
estats_connection_get_agent               \fBestats_connection_accessors\fR(3)
estats_connection_get_cid                 \fBestats_connection_accessors\fR(3)
estats_connection_get_connection_spec     \fBestats_connection_accessors\fR(3)

estats_agent_find_var_from_name           \fBestats_find_var\fR(3)
estats_agent_get_var_head                 \fBestats_find_var\fR(3)
estats_var_next                           \fBestats_find_var\fR(3)

estats_var_get_name                       \fBestats_var_accessors\fR(3)
estats_var_get_type                       \fBestats_var_accessors\fR(3)
estats_var_get_size                       \fBestats_var_accessors\fR(3)

estats_connection_read_access             \fBestats_connection_read\fR(3)
estats_connection_read_value              \fBestats_connection_read\fR(3)
estats_connection_write_value             \fBestats_connection_read\fR(3)

estats_connection_spec_as_strings         \fBestats_connection_spec\fR(3)
estats_connection_spec_compare            \fBestats_connection_spec\fR(3)
.fi
.SH SEE ALSO
.BR estats-config (1)
and section 3 man pages whose name begin "estats_" for
detailed routine descriptions.
